-
-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add hardkernel-odroid-h4-plus docs #903
base: master
Are you sure you want to change the base?
Conversation
fa4d4e1
to
5f07834
Compare
5f07834
to
e162fab
Compare
12953f1
to
befecc5
Compare
746fa1f
to
07655bc
Compare
1. Move the flash selector jumper to select the backup flash chip. If the | ||
device does not boot from any of the flash chips, an external recovery | ||
needs to be performed. In that case continue with the recovery instructions | ||
for the ODROID H4 model. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@philipandag please link that section I guess you mean "External flashing"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably this https://wiki.odroid.com/odroid-h4/hardware/restore_h4_bios#using_tool_and_soldering_skills and https://wiki.odroid.com/odroid-h3/hardware/restore_h3_bios_usbprogrammer#with_usb_programmer_module_ch341a.
Had to test this recovery and it worked (flashed only one SPI, second one recovered with flashrom -p internal
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please link that section I guess you mean "External flashing"
Yes, the sections were renamed and I didn't update this sentence.
aa4abb3#diff-63d4fe5312d3d5c9d0e564e54adf0e43958113fb5d526eb698cd0ff31bd3dc79L19-L21
Do we want to give an URL to the instructions from wiki.odroid.com? If the point of this documentation is only to help the users maybe it would be better to only redirect them to the wiki instead of writing pretty much the same instructions again? I have added the URL to ODROID wiki instructions on flashing using the CH341A programmer as a second tab of the External Flashing section. a3a7f52
In that case maybe an URL to the dual-bios recovery method should also be referenced? The wiki tells how to do it on Windows and using the EFI shell, that might be useful to some users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the point of this documentation is only to help the users maybe it would be better to only redirect them to the wiki instead of writing pretty much the same instructions again?
We can link only if instructions are followed without comment, adjustment, or modification. Otherwise, we should write our own, which does not require such additional information.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation on odroid wiki includes instructions on flashing from UEFI shell and Windows which weren't tested by us, so I can't tell if they would require any additional information. Some weird flashing software which you need to launch from a USB drive is used there. Flashing using flashrom is not described on the wiki, so it does not overlap with what we have in our documentation, it may be included as an additional source.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a link to the documentation at ODROID Wiki.
3eae756
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a link to ODROID H3, not H4. It may cause confusion and problems for users who will expect to see the same things as on the pictures under the link. Unless there is a link to H4 documentation with external programming, I would either remove it or write our own...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's the instruction they link under the H4 documentation saying it's the same for both H3 and H4. I think we could also note that it's valid for both models.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please do so.
783fadb
to
78c2068
Compare
45e632d
to
782894f
Compare
0202334
to
17b90ac
Compare
There must be something wrong with the linkchecker, because every URL it lists as broken works fine for me. |
@philipandag there's a trailing |
There actually is one link added in this PR which the linkChecker marks as broken. It's in the |
@philipandag maybe do a rebase? The link to zero touch initial deployment section should be different because that part is in |
![](../../images/odroid_h4.jpg) | ||
</center> | ||
|
||
Hardkernel ODROID-H4 PLUS is a small open-source hardware single-board computer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
open-source hardware is a badge given by OSHWA (https://www.oshwa.org/). I doubt ODROID has been submitted for OSHW badge (at least I am not aware). I think we should rephrase it to something like just a single-board computer with public schematics and documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right. I shouldn't use the term "open-source hardware" so recklessly. It seems they don't even share the PCB schematics.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@philipandag you are only making it worse...
Schematics is public: https://wiki.odroid.com/_media/odroid-h4/hardware/adln-h4_sch_2024-0306.pdf
What does it even mean "rich schematics"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@miczyg1
Alright, that will be fine, right?
https://github.com/Dasharo/docs/compare/e763c67352ec6e2cd175f0a6db15bf8778a088ac..eed1791e7852672e720ed6c81a1afc00fd302e11
c04369b
to
c68a6ad
Compare
That helped with the link checker on my side. There's a broken link in some other file, already present on master. |
9bd48fa
to
e763c67
Compare
Signed-off-by: Filip Gołaś <[email protected]> mkdocs.yml: Add hardkernel odroid h4 pages Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4_plus/releases.md: Add Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/releases.md: Add newsletter subscribe url Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/releases.md: Add note "Coming soon." Co-authored-by: Michał Żygowski <[email protected]> hardkernel_odroid_h4/releases.md: Dasharo Pro Package Signed-off-by: Filip Gołaś <[email protected]> unified/hardkernel/overview.md: Add Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/overview.md: Add missing links Signed-off-by: Filip Gołaś <[email protected]> odroid_h4 overview.md: Add a short description Signed-off-by: Filip Gołaś <[email protected]> odroid_h4 overview.md: Add an image of the device Signed-off-by: Filip Gołaś <[email protected]> odroid_h4 overview.md: Add link to device's blogpost Signed-off-by: Filip Gołaś <[email protected]> odroid_h4 overview: Remove the term "open source hardware" Signed-off-by: Filip Gołaś <[email protected]> unified/hardkernel/building-manual.md: Add Signed-off-by: Filip Gołaś <[email protected]> Update docs/variants/hardkernel_odroid_h4/building-manual.md Co-authored-by: Michał Żygowski <[email protected]> hardkernel_odroid_h4/building-manual.md: Remove tab Signed-off-by: Filip Gołaś <[email protected]> unified/hardkernel/initial-deployment.md: Add Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/initial_deployment.md: Mention DTS Signed-off-by: Filip Gołaś <[email protected]> odroid_h4 initial-deployment.md: Add G3&CMOS reset if fails to boot Signed-off-by: Filip Gołaś <[email protected]> odroid_h4/initial-deployment.md: Update link to DTS zero touch Signed-off-by: Filip Gołaś <[email protected]> unified/hardkernel/firmware-update.md: Add Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/firmware_update.md: update flash command Co-authored-by: Michał Żygowski <[email protected]> Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/firmware_update.md: Mention DTS Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/firmware-update.md: Update section name Co-authored-by: Michał Żygowski <[email protected]> unified/hardkernel/recovery.md: Add Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/recovery.md: Describe using flash jumper Signed-off-by: Filip Gołaś <[email protected]> docs hardkernel: pre-commit Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/recovery.md: Reword dual bios recovery Co-authored-by: Michał Żygowski <[email protected]> hardkernel_odroid_h4/recovery.md: Remove tab Co-authored-by: Michał Żygowski <[email protected]> hardkernel_odroid_h4/recovery.md: Fix redirect to other section Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/recovery.md: URL to ODROID wiki recovery Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/recovery.md: Suggest hard reset after flashing Signed-off-by: Filip Gołaś <[email protected]> odroid_h4 recovery.md: Link dual bios recovery instructions from WIKI Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4_plus/hardware-matrix.md: Add Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/hardware-matrix.md: Fix PSU Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/hardware-matrix.md: Add RAM model from dmidecode Signed-off-by: Filip Gołaś <[email protected]> unified/hardkernel/test-matrix.md: Add only Dasharo Compatibility Signed-off-by: Filip Gołaś <[email protected]> unified/hardkernel/test-matrix.md: Add reference from script Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/test-matrix.md: Add compatibility links hardkernel_odroid_h4/test-matrix.md: Add performance tests Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/test-matrix.md: Add stability Signed-off-by: Filip Gołaś <[email protected]> hardkernel_odroid_h4/test-matrix.md: Add performance Signed-off-by: Filip Gołaś <[email protected]> hard\/test-matrix.md: Align table columns Signed-off-by: Filip Gołaś <[email protected]> odroid_h4 hardware/test matrices: remove SATA Signed-off-by: Filip Gołaś <[email protected]>
e763c67
to
eed1791
Compare
No description provided.